home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / wc3x / camcrc20.zip / CAMS-CRC.DOC < prev    next >
Text File  |  1992-10-29  |  19KB  |  481 lines
  1.               CAMS-CRC Upload Processor for WildCat!
  2.  
  3. DISCLAIMER   . . . . . . . . . . . . . . . . . . . . . . . . .  2
  4. INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . .  3
  5.  
  6. FILES INCLUDED . . . . . . . . . . . . . . . . . . . . . . . .  3
  7.  
  8.      CAMS-CRC.EXE. . . . . . . . . . . . . . . . . . . . . . .  3
  9.      OUTCOMM.EXE . . . . . . . . . . . . . . . . . . . . . . .  3
  10.      NOADD.TXT . . . . . . . . . . . . . . . . . . . . . . . .  3
  11.      SCANFILE.BAT  . . . . . . . . . . . . . . . . . . . . . .  3
  12.      DLPATH.LST  . . . . . . . . . . . . . . . . . . . . . . .  3
  13.      CAMS-CRC.TXT  . . . . . . . . . . . . . . . . . . . . . .  3
  14.      FILE_ID.TXT . . . . . . . . . . . . . . . . . . . . . . .  3
  15.      GIF.TXT . . . . . . . . . . . . . . . . . . . . . . . . .  3
  16.      PKUNZIP.TXT . . . . . . . . . . . . . . . . . . . . . . .  3
  17.      STRIPZIP.TXT  . . . . . . . . . . . . . . . . . . . . . .  3
  18.      VIRUS.TXT . . . . . . . . . . . . . . . . . . . . . . . .  3
  19.      REGISTER.DOC  . . . . . . . . . . . . . . . . . . . . . .  3
  20.  
  21. CAMS-CRC.EXE Parameters. . . . . . . . . . . . . . . . . . . .  4
  22.  
  23.      CAMS-CRC.EXE BUILD/UPLOAD . . . . . . . . . . . . . . . .  4
  24.      BUILD Parameter Options . . . . . . . . . . . . . . . . .  4
  25.  
  26.           /DL:xxxx . . . . . . . . . . . . . . . . . . . . . .  4
  27.           /C:path. . . . . . . . . . . . . . . . . . . . . . .  4
  28.           /R:xx. . . . . . . . . . . . . . . . . . . . . . . .  4
  29.  
  30.      UPLOAD Parameter Options. . . . . . . . . . . . . . . . .  4
  31.  
  32.           /C:path. . . . . . . . . . . . . . . . . . . . . . .  4
  33.           /D . . . . . . . . . . . . . . . . . . . . . . . . .  5
  34.           /F:xxxx. . . . . . . . . . . . . . . . . . . . . . .  5
  35. |         /G . . . . . . . . . . . . . . . . . . . . . . . . .  5
  36.           /R:xx  . . . . . . . . . . . . . . . . . . . . . . .  5
  37.           /SCAN  . . . . . . . . . . . . . . . . . . . . . . .  5
  38.           /STZ . . . . . . . . . . . . . . . . . . . . . . . .  5
  39.  
  40. INSTALLATION . . . . . . . . . . . . . . . . . . . . . . . . .  6
  41.  
  42.      CAMS-CRC.EXE BUILD /R:80 /DL:filename . . . . . . . . . .  6
  43.      BADFILES.BAT. . . . . . . . . . . . . . . . . . . . . . .  6
  44.      DUPFILES.BAT. . . . . . . . . . . . . . . . . . . . . . .  6
  45.      CAMS-CRC.CFG  . . . . . . . . . . . . . . . . . . . . . .  7
  46.      SCANFILE.BAT  . . . . . . . . . . . . . . . . . . . . . .  8
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61. DISCLAIMER
  62.  
  63.       This software is provided without any guarantee, either expressed
  64.       or implied.  All responsibilities for its use rest with the user
  65.       of the software and not the author. 
  66.  
  67.       Cams-CRC software and this document are (C) Copyright 1992 by
  68.       Cam DeBuck Software.  All rights reserved World Wide.
  69.  
  70.  
  71. LICENSE
  72.  
  73.       Cams-CRC is not in the Public Domain.  Cams-CRC is not free.
  74.       Non-registered users are granted a limited, 30-day license to
  75.       determine whether or not the program meets their needs. 
  76.       Continued use of Cams-CRC beyond the 30-day evaluation time
  77.       period requires registration of the program.  Use of non-
  78.       registered copies of Cams-CRC beyond the original evaluation
  79.       period is strictly prohibited.
  80.       No one may modify Cams-CRC for any reason, in any way, including
  81.       but not limited to decompiling-compiling, patching,
  82.       disassembling, or reverse engineering the program.
  83.       Cams-CRC may be copied and distributed to others, subject to the
  84.       above restrictions and the following:
  85.  
  86.              * Cams-CRC must be copied in unmodified form, including the
  87.                file containing this license information.
  88.              * Complete Cams-CRC documentation must be included.
  89.              * No copying fee of any type may be assessed other than basic
  90.                charges for the cost of the copying medium.
  91.              * Cams-CRC may not be distributed with any other software or
  92.                hardware product(s) without the express written permission
  93.                of Cam DeBuck Software.
  94.  
  95.       Sysops (bulletin board SYStem OPerators) may make Cams-CRC
  96.       available for downloading by their users as long as all above
  97.       conditions are met.
  98.  
  99.       Commercial Distributors of Public Domain, ShareWare, or User-
  100.       Supported software may distribute Cams-CRC subject to the above
  101.       conditions only after obtaining specific written permission from
  102.       Cam DeBuck Software and filling out a registration form for
  103.       upgrade notifications.  This condition supersedes any and all
  104.       previous agreements.
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.                      CAMS-CRC Upload Processor for WildCat 3.5
  122.  
  123.   INTRODUCTION
  124.  
  125.      Thank you for purchasing CAMS-CRC Upload Checker.  You'll find this to be
  126. a very FAST program when checking for .ZIP files.  The processing of .GIF files
  127. is a little slower due to the .GIF file format.  CAMS-CRC checks for a VALID
  128. .GIF file by uncompressing and displaying it in it's virtual screen (You cannot
  129. see it, but the program does).  This allows the program to test for a valid
  130. .GIF file.
  131.  
  132.      During the process of both the .ZIP and .GIF files, it gets a 32-bit CRC
  133. of the file and then checks to see if it's in the DATABASE file.  If it is,
  134. then the file is rejected.  A file called DUPS.LOG is always created and is
  135. displayed to the caller after the entire file has been checked (According to
  136. the paramters that you used).  This file will tell the user what files were
  137. duplicates and what percentage were duplicates.  Also, various information
  138. will be sent to the user as certain things are being done.  This will let the
  139. user know what you are doing and will keep the users attention (At least for
  140. a little while).
  141.  
  142.   FILES INCLUDED
  143.   
  144.      You should have the following files on your DISK or .ZIP file:
  145.  
  146.        CAMS-CRC.EXE  - This is the heart of the program
  147.        OUTCOMM.EXE   - This will display the various information out the
  148.                        comport
  149.        NOADD.TXT     - Your BBS ADD (Or N/A) telling where the file came from.
  150.                        If you do not want to add a comment to the ZIP file,
  151.                        leave this file containing a SPACE in it
  152.        SCANFILE.BAT  - A sample SCANFILE.BAT file to use
  153.        DLPATH.LST    - A sample download path file to use with the /DL:x switch
  154.        CAMS-CRC.CFG  - This is a configuration file that needs to be placed in
  155.                        each NODE directory.  It contains some very important
  156.                        information.
  157.  
  158.      The following files are TEXT files that are displayed to the user
  159.      using OUTCOMM.EXE (Which is written by me).  Feel free to modify any of
  160.      these files.  You can use the WildCat Color codes if you wish:
  161.  
  162.        CAMS-CRC.TXT  - Text file explaining that the file is being checked
  163.                        for duplicates.
  164.        FILE_ID.TXT   - Text file explaining that the description file is being
  165.                        extracted from the .ZIP file.
  166.        PKUNZIP.TXT   - Text file explaining that the file is being extracted.
  167.        STRIPZIP.TXT  - Text file explaining that you are removing comments
  168.                        from the .ZIP file.
  169.        VIRUS.TXT     - Text file explaining that you are checking for a virus.
  170.        GIF.TXT       - Text file explaining that the integrity of the GIF is
  171.                        being processed.
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.                                        3
  180.  
  181. CAMS-CRC.EXE Parameters
  182.  
  183.      CAMS-CRC.EXE has several paramters passed to it.  There are currently
  184. two different MODES available.  They are:  BUILD and UPLOAD
  185.  
  186.      These paramters will be the FIRST parameters on the command line with
  187. the optional parameters following (i.e.):
  188.  
  189.     CAMS-CRC.EXE BUILD/UPLOAD [optional flags]
  190.  
  191. BUILD Parameter Options
  192.  
  193.   The BUILD parameter is used to build or append to the DataBase any
  194. files that you have collected (This could be from a CD-ROM, or just
  195. from downloading files from another BBS. This file is a TEXT file. It will
  196. search ALL files and directories within the current directory.  So if you
  197. specify just the I:\ drive by itself (In the TEXT file), the program will
  198. search your entire I drive.
  199.  
  200. [Optional Flags or Paramters]
  201.  
  202.  /DL:xxxx  - Where xxxx represents the full path and name of your .LST
  203.              file.  This paramter is REQUIRED.
  204.  
  205.  /C:path   - If you wish to specify where you want the *.CR? files created,
  206.              then you will need to specify the PATH of the database files.
  207.              This is an OPTIONAL paramter.  The default is in the current
  208.              directory.
  209.  
  210.  /R:xx     - This is the Ratio to use for Duplicate ZIP files.  The
  211.              default is set to 70 percent.  Because some authors will only update
  212.              their EXE files or HISTORY files, it is necessary sometimes to
  213.              have this above 70. This is an OPTIONAL paramter.
  214.  
  215.  
  216. UPLOAD Parameter Options
  217.  
  218.   The UPLOAD parameter is used to test an INDIVIDUAL file from WildCat.  This
  219.   may be a .ZIP or .GIF file.  If anything else is specified, then nothing
  220.   will happen.
  221.  
  222.  
  223. [Optional Flags or Paramters]
  224.  
  225.  /C:path   - If you wish to specify where the CAMS-CRC.CRC file is located,
  226.              then you will need to specify the PATH of the database files.
  227.              This is necessary when running a multi-node BBS.
  228.              This is an OPTIONAL paramter.  The default is in the current
  229.              directory.  If you're running a multi-node system, I suggest
  230.              that you use this paramter.
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.                                        4
  240.  
  241. /D        -  Tells the program to add the Newest and Oldest Files in
  242.              description of the file.  It also adds the total number of Files
  243.              within a ZIP.  This paramter only works with .ZIP files.  It works
  244.              only if a FILE_ID.DIZ file is found (Until WC changes something).
  245.  
  246.  /F:xxxx   - This is the full path and name of the file to test.  If
  247.              you are using this via your SCANFILE.BAT file, then all
  248.              you need to do is use the %1 paramter (i.e., /F:%1 ).
  249.              This paramter is REQUIRED.
  250.  
  251. | /G       - If processing a GIF file, this tells the program to add
  252. |            the screen resolution and the COLOR of the GIF to the DIR
  253. |            file.  This only works .GIF files.  It is an OPTIONAL parameter.
  254.  
  255.  /R:xx     - This is the Ratio to use for Duplicate ZIP files.  The
  256.              default is set to 70 percent.  This means that a user can
  257.              have up to 69 percent of dups before the file is rejected.
  258.              Because some authors will only update their EXE files or HISTORY
  259.              files, it is necessary sometimes to have this above 70.
  260.              I personally like using 50% ratio.  This is an OPTIONAL paramter.
  261.  
  262.  /SCAN     - This tells the program to use SCAN.EXE to check for a virus.
  263.              Be sure you enable your SCANOPTIONS in the CAMS-CRC.CFG for
  264.              each node. This is an OPTIONAL paramter.
  265.  
  266.  /STZ      - This will remove any ZIP comments and place a ZIP comment of
  267.              your own.  You will need to modify the NOADD.TXT file if you
  268.              want your own ZIP comment added.  This is an OPTIONAL parameter.
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.                                        5
  300.   INSTALLATION
  301.   
  302.      First, you will need to create a directory.  I suggest \CAMS-CRC.  Unzip
  303. the the CAMCRCxx.ZIP (Where xx is the version number) into this directory.
  304.  
  305.      Second, you will need to create a TEXT file that has all the paths to your
  306. files.  Each path will need to be on a seperate line.  If you have dedicated
  307. a hard drive to just files, then make your life easier by simply defining the
  308. Drive.  An example file can look like this:
  309.  
  310. C:\FILES\WINDOWS
  311. C:\FILES\GIFS
  312. D:\
  313. E:\
  314. F:\
  315.  
  316.      The above example could of been simplied for the first two paths by using
  317. C:\FILES.  Remember, that the program will check the current directory and
  318. any directions within the current directory for .ZIP of .GIF files.  The last
  319. three paths will tell the program to search the entire hard drive for .ZIP or
  320. .GIF files.
  321.  
  322.      Depending on the number of .GIF files you have (And how fast your computer
  323. is), this process may take a while.  You will notice that .ZIP files will FLY
  324. on by.
  325.  
  326.      Once you have created your TEXT file, you will need to build your initial
  327. database.  This is very simple.  Just do this:
  328.  
  329.     CAMS-CRC.EXE BUILD /R:80 /DL:filename  (Where filename is the name of the
  330.                                            text file you just created)
  331.  
  332.      After the program has completed, you will find two BATCH files and a
  333.      DUPS.LOG.  The DUPS.LOG contains information pertaining for each .ZIP
  334.      or .GIF file.  Use this as a reference.
  335.  
  336.      The BATCH files are called:
  337.  
  338.       BADFILES.BAT  - This contains any Bad Files that were found during the
  339.                       initial build.  Basically, these should be corrupted
  340.                       files (.GIF or .ZIP).  It is possible that your .ZIP
  341.                       files will be good if they were compressed with an
  342.                       earlier version of PKZip.  This program requires that
  343.                       all files be created using PKZip v1.10.
  344.  
  345.       DUPFILES.BAT  - These will contain the path to any Duplicate Files that
  346.                       were found during the build process.
  347.  
  348.     NOTE:  These BATCH files contain a statement to DELETE these files.  If
  349.            you want to remove these duplicates or bad files, simply type in
  350.            the name of the batch file and they will be removed.  You will then
  351.            need to run WCFILE and remove the file descriptions.
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.                                        6
  360.  
  361. CAMS-CRC.CFG File
  362.  
  363.      You will need to make sure you create a CAMS-CRC.CFG file in each
  364. NODE Directory.  The CAMS-CRC.CFG contains 5 lines (Some of which are
  365. optional).  The order doesn't matter, but make sure everything is in CAPS:
  366.  
  367.        WCFILEOPTIONS=  :  This is the options to use for WCFILE.EXE.  Be sure
  368.                           you use these command line options: /E /F /K
  369.                           Do NOT use /A: as I automatically figure this
  370.                           information out.
  371.  
  372.        FILEAREADAT=    :  This is the PATH/NAME of your FILEAREA.DAT file.  This
  373.                           is used in conjunction with the WCFILEOTPIONS.  It's
  374.                           very important that you have this set correctly.
  375.  
  376.        SCANOPTION=     :  This is the option(s) to use for SCAN.EXE.  SCAN.EXE
  377.                           is a Virus Scanning program McAfee Associates.  See
  378.                           the documentation on what options you want to set.
  379.                           My example CAMS-CRC.CFG has some normal settings
  380.                           which work very nicely.
  381.  
  382.        WORKPATH=       :  This is the temporary WORK directory to use.  Each
  383.                           NODE needs to have its own WORK directory.  If you
  384.                           give two nodes the same directory, you will only
  385.                           cause problems.  Be sure you use a different
  386.                           directory for each node.  I suggest the WORK
  387.                           directory be off of the ROOT directory.
  388.  
  389.        OLDESTFILE      :  During an Upload Process, you can specify what the
  390.                           oldest file in the archive can be (In the format of
  391.                           MM/DD/YY).  If one file is found, the entire upload
  392.                           will fail.  The DUPS.LOG (Which you should rename
  393.                           during the upload process) will contain information
  394.                           that the file failed because of being out of date.
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.                                        7
  420.  
  421. INSTALLING SCANFILE.BAT
  422.  
  423. Installing the SCANFILE.BAT file is very simple.  I suggest that you use our
  424. example SCANFILE.BAT file and modify it to fit your needs.  In most cases you
  425. will find that you won't have to do anything to it.
  426.  
  427. When a file is uploaded (This can be done locally or remotely), the DUPS.LOG
  428. file is created.  It's very important that you delete this file after the
  429. file has been processed.  I suggest that you copy it to another file and purge
  430. it when you feel it's necessary.  You'll find that our example SCANFILE.BAT
  431. file does this.  A SCANFILE.BAT goes in each of your NODE Directories.
  432.  
  433. Here is a sample SCANFILE.BAT file:
  434.  
  435. echo off
  436. echo Delete the SCANFILE.BAD file (Just in case it might exist)
  437. IF EXIST SCANFILE.BAD DEL SCANFILE.BAD
  438.  
  439. echo Now let's do the REAL WORK
  440. CAMS-CRC UPLOAD /C:C:\CAMS-CRC /F:%1 /D /R:50 /SCAN
  441.  
  442. echo Display the DUPS.LOG file so the user can see what percentage of dups.
  443. OUTCOMM.EXE DUPS.LOG
  444.  
  445. echo Copy the DUPS.LOG to a permanent file
  446. echo This is NOT necessary, but it keeps a RUNNING log of everything.
  447. copy C:\CAMS-CRC\ALL-DUPS.LOG+DUPS.LOG ALL-DUPS.LOG
  448.  
  449. echo Delete the DUPS.LOG file
  450. del DUPS.LOG
  451. IF EXIST WCFILE.LOG DEL WCFILE.LOG
  452.  
  453. Additional Information
  454.  
  455.   You will notice a "|" character at the beginning of a new line.  This
  456.   indicates that this feature has been removed due to the way WildCat! works.
  457.   If WildCat! would create a DESCRIPT file (Which would tell the program what
  458.   type of description the user entered via the BBS), I could then add some
  459.   additional information.  OR if WildCat would add an option to the WCFILE.EXE
  460.   to generate a TEXT file of the description, I could then enable the option.
  461.   Please ask Mustang Software, Inc. to add such a feature!
  462.  
  463.   When WCFILE.EXE is excuted, it will SOMETIMES leave behind a WCFILE.LOG.  I
  464. have no idea why it is doing this, but I suggest that you add to your
  465. SCANFILE.BAT an "IF EXIST WCFILE.LOG DEL WCFILE.LOG".  Also, when WCFILE.EXE
  466. runs, it might generate a WCFILE.ERR.  This should NOT be deleted until the
  467. Sysop checks it out.
  468.  
  469.      If you have any problems, please contact me at:
  470.  
  471.       BBS (801)489-3558 [HST 1440]
  472.     VOICE (801)489-4878 [M-F 9 to 5, Sat 9 to 12]
  473.  
  474.     Order using: Visa, MasterCard, Discover, Diners Club or JCB Cards,
  475.  
  476.     Please call:  ORDERS ONLY  1-800-392-8892  [M-F 9 to 5, Sat 9 to 12]
  477.  
  478.  
  479.                                        8
  480.  
  481.